Skip to content

Improve Interactive CLI documentation #20013

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Improve Interactive CLI documentation #20013

wants to merge 11 commits into from
+151 −17

Conversation

pnv1
Copy link
Collaborator

@pnv1 pnv1 commented Jun 22, 2025

Changelog entry

Changelog category

  • Documentation (changelog entry is not required)

Description for reviewers

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jun 22, 2025
@github-actions GitHub Actions
Copy link

🟢 2025-06-22 19:02:55 UTC The validation of the Pull Request description is successful.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 22, 2025 •
edited
Loading

⚪ 2025-06-22 19:03:11 UTC Pre-commit check linux-x86_64-release-asan for f6e41ce has started.
⚪ 2025-06-22 19:03:37 UTC Artifacts will be uploaded here
⚪ 2025-06-22 19:07:03 UTC ya make is running...
🟢 2025-06-22 19:07:08 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-06-22 19:07:14 UTC Build successful.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 22, 2025 •
edited
Loading

⚪ 2025-06-22 19:03:18 UTC Pre-commit check linux-x86_64-relwithdebinfo for f6e41ce has started.
⚪ 2025-06-22 19:03:30 UTC Artifacts will be uploaded here
⚪ 2025-06-22 19:05:59 UTC ya make is running...
🟢 2025-06-22 19:06:04 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-06-22 19:06:10 UTC Build successful.

@github-actions GitHub Actions
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

Build logs

Warnings (2)

⚠️ en/reference/ydb-cli/interactive-cli.md: 13: MD022 / blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Features {#features}"]

⚠️ en/reference/ydb-cli/interactive-cli.md: 14: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "* [Query history](#query-histo..."]

@ydbot
Copy link
Collaborator

ydbot commented Jun 23, 2025

🔄 New commits pushed — @ElenaAfina please take a look.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 23, 2025 •
edited
Loading

⚪ 2025-06-23 08:40:26 UTC Pre-commit check linux-x86_64-relwithdebinfo for 578dc36 has started.
⚪ 2025-06-23 08:40:57 UTC Artifacts will be uploaded here
⚪ 2025-06-23 08:44:05 UTC ya make is running...
🟢 2025-06-23 08:44:11 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-06-23 08:44:17 UTC Build successful.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 23, 2025 •
edited
Loading

⚪ 2025-06-23 08:41:07 UTC Pre-commit check linux-x86_64-release-asan for 578dc36 has started.
⚪ 2025-06-23 08:41:19 UTC Artifacts will be uploaded here
⚪ 2025-06-23 08:43:55 UTC ya make is running...
🟢 2025-06-23 08:44:00 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-06-23 08:44:06 UTC Build successful.

@github-actions GitHub Actions
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

Build logs

Warnings (4)

⚠️ en/reference/ydb-cli/interactive-cli.md: 13: MD022 / blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Features {#features}"]

⚠️ en/reference/ydb-cli/interactive-cli.md: 14: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "* [Query history](#query-histo..."]

⚠️ ru/reference/ydb-cli/interactive-cli.md: 13: MD022 / blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Возможности {#features}"]

⚠️ ru/reference/ydb-cli/interactive-cli.md: 14: MD032 / blanks-around-lists Lists should be surrounded by blank lines [Context: "* [История запросов](#query-hi..."]

@ydbot
Copy link
Collaborator

ydbot commented Jun 23, 2025

🔄 New commits pushed — @ElenaAfina please take a look.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 23, 2025 •
edited
Loading

⚪ 2025-06-23 09:42:20 UTC Pre-commit check linux-x86_64-relwithdebinfo for 08aa085 has started.
⚪ 2025-06-23 09:42:26 UTC Artifacts will be uploaded here
⚪ 2025-06-23 09:44:51 UTC ya make is running...
🟢 2025-06-23 09:44:56 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-06-23 09:45:02 UTC Build successful.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 23, 2025 •
edited
Loading

⚪ 2025-06-23 09:42:37 UTC Pre-commit check linux-x86_64-release-asan for 08aa085 has started.
⚪ 2025-06-23 09:42:48 UTC Artifacts will be uploaded here
⚪ 2025-06-23 09:45:16 UTC ya make is running...
🟢 2025-06-23 09:45:22 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-06-23 09:45:28 UTC Build successful.

@pnv1 pnv1 marked this pull request as ready for review June 23, 2025 10:08
@pnv1 pnv1 requested a review from a team as a code owner June 23, 2025 10:08
@ydbot
Copy link
Collaborator

ydbot commented Jun 24, 2025

Hey @ElenaAfina, it has been 30 business-hours since the author's last update, could you please review?

ElenaAfina
ElenaAfina requested changes Jun 24, 2025
View reviewed changes
@ydbot
Copy link
Collaborator

ydbot commented Jun 24, 2025

🔄 New commits pushed — @ElenaAfina please take a look.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 24, 2025 •
edited
Loading

⚪ 2025-06-24 12:18:49 UTC Pre-commit check linux-x86_64-relwithdebinfo for 7d5322a has started.
⚪ 2025-06-24 12:19:22 UTC Artifacts will be uploaded here
⚪ 2025-06-24 12:22:26 UTC ya make is running...
🟢 2025-06-24 12:22:32 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-06-24 12:22:37 UTC Build successful.

@github-actions GitHub Actions
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 24, 2025 •
edited
Loading

⚪ 2025-06-24 12:25:53 UTC Pre-commit check linux-x86_64-release-asan for 7d5322a has started.
⚪ 2025-06-24 12:26:01 UTC Artifacts will be uploaded here
⚪ 2025-06-24 12:28:27 UTC ya make is running...
🟢 2025-06-24 12:28:32 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-06-24 12:28:38 UTC Build successful.

@ydbot
Copy link
Collaborator

ydbot commented Jun 24, 2025

🔄 New commits pushed — @ElenaAfina please take a look.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 24, 2025 •
edited
Loading

⚪ 2025-06-24 17:01:01 UTC Pre-commit check linux-x86_64-release-asan for 4a4650a has started.
⚪ 2025-06-24 17:01:23 UTC Artifacts will be uploaded here
⚪ 2025-06-24 17:04:23 UTC ya make is running...
🟢 2025-06-24 17:04:28 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-06-24 17:04:34 UTC Build successful.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 24, 2025 •
edited
Loading

⚪ 2025-06-24 17:02:03 UTC Pre-commit check linux-x86_64-relwithdebinfo for 4a4650a has started.
⚪ 2025-06-24 17:02:25 UTC Artifacts will be uploaded here
⚪ 2025-06-24 17:04:49 UTC ya make is running...
🟢 2025-06-24 17:04:54 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-06-24 17:05:00 UTC Build successful.

@github-actions GitHub Actions
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

ElenaAfina
ElenaAfina requested changes Jun 25, 2025
View reviewed changes
@ydbot
Copy link
Collaborator

ydbot commented Jun 25, 2025

🔄 New commits pushed — @ElenaAfina please take a look.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 25, 2025 •
edited
Loading

⚪ 2025-06-25 13:45:41 UTC Pre-commit check linux-x86_64-release-asan for 52e3232 has started.
⚪ 2025-06-25 13:46:14 UTC Artifacts will be uploaded here
⚪ 2025-06-25 13:49:48 UTC ya make is running...
🟢 2025-06-25 13:49:53 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-06-25 13:49:59 UTC Build successful.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 25, 2025 •
edited
Loading

⚪ 2025-06-25 13:49:21 UTC Pre-commit check linux-x86_64-relwithdebinfo for 52e3232 has started.
⚪ 2025-06-25 13:49:33 UTC Artifacts will be uploaded here
⚪ 2025-06-25 13:52:00 UTC ya make is running...
🟢 2025-06-25 13:52:06 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-06-25 13:52:13 UTC Build successful.

@github-actions GitHub Actions
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

@ydbot
Copy link
Collaborator

ydbot commented Jun 25, 2025

🔄 New commits pushed — @ElenaAfina please take a look.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 25, 2025 •
edited
Loading

⚪ 2025-06-25 16:07:15 UTC Pre-commit check linux-x86_64-release-asan for 909b3f5 has started.
⚪ 2025-06-25 16:07:26 UTC Artifacts will be uploaded here
⚪ 2025-06-25 16:09:55 UTC ya make is running...
🟢 2025-06-25 16:10:01 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-06-25 16:10:07 UTC Build successful.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 25, 2025 •
edited
Loading

⚪ 2025-06-25 16:22:43 UTC Pre-commit check linux-x86_64-relwithdebinfo for 909b3f5 has started.
⚪ 2025-06-25 16:22:49 UTC Artifacts will be uploaded here
⚪ 2025-06-25 16:25:12 UTC ya make is running...
🟢 2025-06-25 16:25:17 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-06-25 16:25:23 UTC Build successful.

@pnv1 pnv1 added the rebase-and-check Rebase PR with the current base branch and check label Jun 26, 2025
@github-actions github-actions bot removed the rebase-and-check Rebase PR with the current base branch and check label Jun 26, 2025
@ydbot
Copy link
Collaborator

ydbot commented Jun 26, 2025

🔄 New commits pushed — @ElenaAfina please take a look.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 26, 2025 •
edited
Loading

⚪ 2025-06-26 05:05:11 UTC Pre-commit check linux-x86_64-relwithdebinfo for 1c821ca has started.
⚪ 2025-06-26 05:05:23 UTC Artifacts will be uploaded here
⚪ 2025-06-26 05:07:53 UTC ya make is running...
🟢 2025-06-26 05:07:58 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-06-26 05:08:04 UTC Build successful.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 26, 2025 •
edited
Loading

⚪ 2025-06-26 05:06:41 UTC Pre-commit check linux-x86_64-release-asan for 1c821ca has started.
⚪ 2025-06-26 05:06:53 UTC Artifacts will be uploaded here
⚪ 2025-06-26 05:09:27 UTC ya make is running...
🟢 2025-06-26 05:09:32 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-06-26 05:09:38 UTC Build successful.

ElenaAfina
ElenaAfina requested changes Jun 26, 2025
View reviewed changes
@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 26, 2025 •
edited
Loading

⚪ 2025-06-26 08:41:06 UTC Pre-commit check linux-x86_64-release-asan for e5175a4 has started.
⚪ 2025-06-26 08:41:18 UTC Artifacts will be uploaded here
⚪ 2025-06-26 08:43:51 UTC ya make is running...
🟢 2025-06-26 08:43:57 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-06-26 08:44:04 UTC Build successful.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 26, 2025 •
edited
Loading

⚪ 2025-06-26 08:44:27 UTC Pre-commit check linux-x86_64-relwithdebinfo for e5175a4 has started.
⚪ 2025-06-26 08:44:53 UTC Artifacts will be uploaded here
⚪ 2025-06-26 08:47:47 UTC ya make is running...
🟢 2025-06-26 08:47:53 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2025-06-26 08:48:00 UTC Build successful.

@ydbot
Copy link
Collaborator

ydbot commented Jun 26, 2025

🔄 New commits pushed — @ElenaAfina please take a look.

@github-actions GitHub Actions
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ElenaAfina ElenaAfina ElenaAfina requested changes

Requested changes must be addressed to merge this pull request.

Assignees

@ElenaAfina ElenaAfina

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@pnv1 @ydbot @ElenaAfina